package com.zdpx.pxframework.system.api;

import com.zdpx.pxframework.core.vo.PageResult;
import com.zdpx.pxframework.core.vo.Result;
import com.zdpx.pxframework.security.annotation.InnerAuth;
import com.zdpx.pxframework.system.api.entity.RoleInfo;
import com.zdpx.pxframework.system.vo.query.RoleInfoQuery;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;

import java.util.List;
import java.util.Set;


/**
 * 角色 接口Swagger Api
 *
 * @Description:
 * @Author: Cheng XiaoXiao
 * @Date: 2022-02-27 15:20:14
 */
@Api(tags = "角色模块", description = "实现对角色数据的基本操作")
public interface RoleInfoControllerApi {


    /**
     * 按照条件查询角色信息
     *
     * @param roleInfoQuery 查询条件
     * @return 结果信息
     */
    @ApiOperation(value = "按照条件查询角色信息")
    Result<List<RoleInfo>> list(RoleInfoQuery roleInfoQuery);

    /**
     * 分页及条件查询角色信息
     *
     * @param page          页码
     * @param size          分页大小
     * @param roleInfoQuery 查询条件
     * @return 分页结果信息
     */
    @ApiOperation(value = "分页及条件查询角色信息")
    Result<PageResult<RoleInfo>> search(@ApiParam(name = "page", value = "当前页", required = true, type = "path") Long page,
                                        @ApiParam(name = "size", value = "页码大小", required = true, type = "path") Long size,
                                        RoleInfoQuery roleInfoQuery);

    /**
     * 根据ID获取角色详情
     *
     * @param id 角色ID
     * @return 角色详细信息
     */
    @ApiOperation(value = "获取单个角色详情")
    @ApiParam(name = "id", value = "角色ID", required = true, type = "path")
    Result<RoleInfo> detail(String id);

    /**
     * 增加角色信息
     *
     * @param roleInfo 角色增加实体
     * @return 增加后的角色信息
     */
    @ApiOperation(value = "增加角色信息")
    Result<RoleInfo> add(RoleInfo roleInfo);

    /**
     * 修改角色信息
     *
     * @param id       角色ID
     * @param roleInfo 角色修改实体
     * @return 修改后的角色信息
     */
    @ApiOperation(value = "修改角色信息")
    Result<RoleInfo> updateById(@ApiParam(name = "id", value = "角色ID", type = "path") String id, RoleInfo roleInfo);

    /**
     * 删除角色信息
     *
     * @param id 角色ID
     * @return 删除结果信息
     */
    @ApiOperation(value = "删除单个角色信息")
    Result<Boolean> deleteById(@ApiParam(name = "id", value = "角色ID", type = "path") String id);

    /**
     * 删除角色信息
     *
     * @param idList 角色ID数组
     * @return 删除结果信息
     */
    @ApiOperation(value = "批量删除角色信息")
    Result<Boolean> batchRemove(List<String> idList);

    /**
     * 根据用户ID获取拥有的角色标识列表
     *
     * @param userId 用户ID
     * @return 角色标识列表
     */
    @ApiOperation(value = "根据用户ID获取角色标识列表")
    @InnerAuth
    Result<Set<String>> getRoleKeysByUserId(@ApiParam(name = "userId", value = "用户ID", type = "path") String userId);


    /**
     * 根据角色标识数组，获取角色列表
     *
     * @param roleKeys 角色标识数组
     * @return 角色列表
     */
    @ApiOperation(value = "根据角色标识数组，获取角色列表")
    @InnerAuth
    Result<List<RoleInfo>> listByRoleKeys(@ApiParam(name = "roleKeys", value = "角色标识数组", type = "param") List<String> roleKeys);
}
